docs: add SECURITY.md - #80
Conversation
Points at security@pgedge.com as the single reporting route and at the pgEdge Vulnerability Disclosure Statement for scope, safe harbour and CVE handling. Identical across every pgEdge product repository. Do not merge before pgEdge/pgedge-docs#138 publishes docs.pgedge.com/security; until it does, the only link in this file 404s.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
💤 Files with no reviewable changes (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe pull request removes ChangesRepository security policy
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: 🟡 Moderate · up to This change replaces the repository’s dead reporting-form route with an email address and a documentation link, but the linked security page is currently reported as returning 404. Merging now would publish a policy with a dead actionable link, so merge should wait for the documentation update or explicit acceptance. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Up to standards ✅🟢 Issues
|
It pointed reporters at security/advisories/new, GitHub's private vulnerability reporting form. That is disabled org-wide and stays disabled, so the link is dead and the file offered no email fallback. It also promised a fix timeline, which is not something we have approved. A file in .github/ takes precedence over one in the root, so the new root SECURITY.md does not supersede it on its own.
Adds
SECURITY.mdto the repository root. It names security@pgedge.com asthe single reporting route and points at the pgEdge Vulnerability Disclosure
Statement for scope, safe harbour and CVE handling.
The file is identical in every pgEdge product repository — nothing in it is
repo-specific.
Why an in-repo copy when there is an org default
pgEdge/.githubcarries the same file as an organisation default, which coversevery repository that has none of its own. Defaults do not appear in a
repository's file tree, git history, clones or release archives — only in the
Security tab. A product a customer clones or vendors should carry its own
policy, and OpenSSF Scorecard's security-policy check only looks in the
repository itself.
Draft on purpose — merge order matters
The only link in this file is
https://docs.pgedge.com/security, and that URLreturns 404 today. Merging before the statement is live publishes a
security policy whose one actionable link is dead.
Merge order:
docs.pgedge.com/security. Out ofdraft and awaiting review.
No action needed from you until #138 merges. Reviews welcome now.
Also removes
.github/SECURITY.mdThis repository already carried its own policy at
.github/SECURITY.md. Itdirected reporters to
security/advisories/new— GitHub's privatevulnerability reporting form, which is disabled across the pgEdge org and stays
disabled — so the link was dead, and there was no email fallback. It also
promised a fix timeline, which has not been approved.
A file in
.github/takes precedence over one in the repository root, so thenew root file does not supersede it on its own. It has to go in the same PR or
coldfrontkeeps serving the dead link.